Image

Image properties

Name Description Inherited Exported to Kanzi Engine
Tags List of tags attached to the item No No
Effective Data Context The data context in the current node that is resolved from data context properties and bindings No No
Image The image to display. No Yes

Image available properties

Name Description Inherited Exported to Kanzi Engine
Disable KZB Export Disables the exporting of the item into KZB. Can be used for, e.g. letting items out from certain profiles. The disabled items are always included in preview. No No
Bindings The list of expression property bindings the item is part of No No
Brush Color Color for brush. Set alpha to 0 to disable brush. No Yes
Brush Texture Texture for brush. No Yes
Layout Height The height of the node when used in a layout. Overrides the default bounds of the item. No Yes
Layout Width The width of the node when used in a layout. Overrides the default bounds of the item. No Yes
Global Ambient Color The color that is multiplied automatically with the "Ambient" property of the materials in the scene. No Yes
Glyph Texture The automatic texture of the glyph cache No Yes
Font Color Sets the color of the text. No Yes
Texture1 Sets the second texture you want the Blit Render Pass to blit. No Yes
Texture2 Sets the third texture you want the Blit Render Pass to blit. No Yes
Texture3 Sets the fourth texture you want the Blit Render Pass to blit. No Yes
Texture0 Sets the first texture you want the Blit Render Pass to blit. No Yes
Blend Intensity Controls the intensity how materials are blended on top of the existing color.
Attached property enables overriding of the blend intensity of the used materials at render pass or object node level		 No Yes
Ambient Color The color of the material when no light are present No Yes
Diffuse Color The color of the material when it is lit by a light No Yes
Emissive Color The color of the light that is emitted from the material surface No Yes
Mask Texture Texture for masking other texture or color No Yes
Mask Texture Offset Sets an offset for mask in materials No Yes
Mask Texture Tiling Determines how many times mask is presented in material No Yes
Specular Color The color of the specular reflection No Yes
Specular Exponent Determines the size of the specular highlight No Yes
Texture The texture of the material No Yes
Texture Offset Sets an offset for texture in materials No Yes
Texture Tiling Determines how many times texture is presented in material No Yes
Blend Mode Controls how blending is performed. Attached property enables overriding of the blend mode of the used materials at render pass or object node level.
Use "Alpha: Automatic" setting to use premultiplied or non-premultiplied alpha depending on the value of "Use Premultiplied Alpha by Default" project setting.		 No Yes
Tags List of tags attached to the item No No
Data Context Source of data for this node and its descendants No Yes
Actual Layout Height The calculated height of the node when used in a layout. No Yes
Actual Layout Width The calculated width of the node when used in a layout. No Yes
Horizontal Margin Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
To set the Horizontal Margin property fields in a binding use:
- Vector_X to access the Left property field
- Vector_Y to access the Right property field		 No Yes
Vertical Margin Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
To set the Vertical Margin property fields in a binding use:
- Vector_X to access the Bottom property field
- Vector_Y to access the Top property field		 No Yes
Bottom Image The image to use in middle of the bottom row. No Yes
Bottom-Left Image Image to use in the bottom-left corner. No Yes
Bottom-Right Image The image to use in the bottom-right corner. No Yes
Center Image The image to use in the center. No Yes
Left Image The image to use in the center-left. No Yes
Right Image The image to use in the center-right. No Yes
Top Image The image to use in the middle of the top row. No Yes
Top-Left Image The image to use in the top-left corner. No Yes
Top-Right Image The image to use in the top-right corner. No Yes
Focused Indicates whether the node has actives focus. No Yes
Logical Focus Indicates whether the node has logical focus. No Yes
Node.Path Node full path. No Yes
Is Value Changing Whether or the value is currently changing. No Yes
Maximum Value The maximum value that the range allows. No Yes
Minimum Value The minimum value that the range allows. No Yes
Normalized Value The current value normalized to range [0, 1]. No Yes
Step Value The minimum amount that the value of the range can change at a time. No Yes
Value The current value. No Yes
State Manager State Manager applied to the current node No Yes
Style Style applied to the current node No Yes
Maximum Distance From Curve The distance from the curve where hit testing succeeds. No Yes
Horizontal Padding Sets the padding spaces between the content and the left and right boundaries of the text block. No Yes
Vertical Padding Sets the padding spaces between the content and the top and bottom boundaries of the text block. No Yes
Baseline Font baseline in 3D space units. No Yes
Two Pass Rendering Defines whether the Text Block 3D is rendered in two passes.
Disabling the two pass rendering improves performance, but can cause invalid rendering results when glyph bounds overlap.		 No Yes
Font The font used to render the text. No Yes
Character Spacing Sets the character spacing in device-independent pixels. No Yes
Constrain Content Height Whether to cut out the last lines that do not fit within the boundaries of the text block. No Yes
Fixed Character Width When set, overrides the font advance widths to make each character take a fixed amount of space specified in device-independent pixels. No Yes
Font Material Sets the material whose shader is used to render the text. The shader must use the ContentTexture uniform which is automatically filled with glyph data. No Yes
Font Size Sets the size of the font in device-independent pixels. No Yes
Line Spacing Sets the line spacing in multiples of the normal line height of the selected font. No Yes
Overflow Sets the characters that represent the clipped text when the text string to be rendered is too long to fit in the node. No Yes
Remove Side Bearings Whether to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text block. No Yes
Text Sets the text content that the text block renders.
To create a line break press Shift+Enter.		 No Yes
Text Horizontal Alignment Sets the horizontal alignment of the text. No Yes
Text Vertical Alignment Sets the vertical alignment of the text. No Yes
Word Wrap Whether to break long text lines to multiple lines to make the text fit within the boundaries of the text block. No Yes
Opacity Opacity of the node. No Yes
Brush Modulate Color Modulation color for brush. Effects brush rendering that needs color modulation. No Yes
Brush Horizontal Tiling Horizontal Tiling for the brush. Affects the scale of texture coordinates. No Yes
Brush Vertical Tiling Vertical Tiling for the brush. Affects the scale of texture coordinates. No Yes
Export in Asset Package When enabled, this item is exported into asset package if this project is saved as one. No No
Background Brush The background brush to paint the background of 2D nodes. No Yes
Image The image to display. No Yes
Content Stretch Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). No Yes
Aspect Ratio Determines the proportion of width and height. You cannot set both the Aspect Ratio and both, Width and Height. No Yes
Force Composition Force rendering to composing target even if not otherwise necessary. No Yes
Snap to Pixel Snap the translation of the node and its size into pixel boundary. No Yes
Cache Children Cache child nodes into a render target. See also Cache Self. No Yes
Cache Result Cache final result (combination of itself and its children) into a render target. No Yes
Cache Self Cache node contents into a render target. See also Cache Children. No Yes
Disable Render Target Clear Color Do not clear render target buffers before rendering into it even if necessary. No Yes
Off-Screen Rendering When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen. No Yes
Pixel Format The pixel format of the node if rendering to a texture. No Yes
Render Self Whether the node renders itself. Does not affect the rendering of child nodes. No Yes
Render Target Forces the node to be rendered into a given render target texture. When set to "No Target",
regular conditions whether node is rendered to a texture, such as opacity and rotation, are applied.		 No Yes
Render Target Minimum Height Sets the minimum height of implicitly generated render targets. No Yes
Render Target Minimum Width Sets the minimum width of implicitly generated render targets. No Yes
Render Target Reallocation Limit The change in size that triggers reallocation of a render target. No Yes
Layout Transformation The 2D transformation to be applied before layouting. No Yes
Perspective Transformation The 3D transformation to be applied after layouting. No Yes
Render Transformation The 2D transformation to be applied after layouting. No Yes
Render Transformation Origin Sets the render transform origin in relative coordinates. No Yes
Camera Sets which camera to use in scenes rendered by the selected Viewport 2D. If not set, Kanzi uses the camera in the scene. No Yes
Hit Test Camera Sets which hit test camera to use in scenes rendered by the selected Viewport 2D. If not set, Kanzi uses the camera in the scene. No Yes
Render Pass Sets which render pass to use in scenes rendered by the selected Viewport 2D. If not set, Kanzi uses the render pass used by the scene. No Yes
Direction Defines the axis along which the stack layout arranges its items. No Yes
Reversed Defines whether the stack layout arranges its items in reverse order. No Yes
Horizontal Alignment The alignment in horizontal direction the node should use when it resides under a layout. No Yes
Vertical Alignment The alignment in vertical direction the node should use when it resides under a layout. No Yes
Selected Indicates if list box item container is selected. This property is set by list box on container of an item which was selected. No Yes
Calculated Offset Current relative offset of object in a grid list box, in proportional range [0, 1]. No Yes
Visible Amount in Parent Describes how much of an object is inside its parent. Can be used in shaders to implement fades. Calculated by the parent node. No Yes
Calculated Offset Current offset of item caluclated by the trajectory layout in proportional range [0, 1] (read-only). No Yes
Index In Group Defines the index in the group that the button will have. The group must have the button in its tree.
The button searches for the group upwards. When the value is -1 the button picks the nearest group.		 No Yes
Side The docking side of an item in the dock layout. No Yes
Down Navigation Node Set the path to the node to focus on downward direction navigation. No Yes
Focus Scope Set to true if the node is a focus scope. No Yes
Left Navigation Node Set the path to the node to focus on left direction navigation. No Yes
Next Focus Node Set the path to the node to focus on forward focus navigation. No Yes
Previous Focus Node Set the path to the node to focus on backward focus navigation. No Yes
Right Navigation Node Set the path to the node to focus on right direction navigation. No Yes
Up Navigation Node Set the path to the node to focus on upward direction navigation. No Yes
Column The column into which grid layout places the item. No Yes
Column Span Defines the number of columns an item in a grid layout occupies. No Yes
Row The row into which grid layout places the item. No Yes
Row Span Defines the number of rows an item in a grid layout occupies. No Yes
Click Enabled Whether to install a click manipulator that generates click messages. No Yes
Double-Click Enabled Whether to install a multi-click manipulator that generates double-click messages. No Yes
Stretch Scale the trajectory to match layout size. No Yes
Trajectory Override Offset Current offset of item manually set, which is otherwise calculated by the trajectory layout. No Yes
Auto Press Interval An interval in milliseconds after which a held down button sends a button click message.
Set to 0 to disable.		 No Yes
Down On Hover When enabled, holding a finger on a device screen and moving it over the button, the property transitions the button to the down state. No Yes
Hold Interval Occurs when the button is in down state for the set amount of milliseconds.
Set to 0 to disable.		 No Yes
Is Down Whether the button is in down state. No Yes
Toggle State The current toggle state of the toggle button. No Yes
Toggle State Count The number of toggle states of the toggle button. No Yes
Hit Testable When enabled, users can pick the object node from the active scene's default 3D camera. For example, hit testing is needed for button components to work. No Yes
Clip Children Specified whether or not the children should be clipped. Children whose bounding box is completely outside the bounding box of the parent are clipped.
The property is to be used with layout nodes. The children should only use transformation that contain only translation.		 No Yes
Focusable Indicates whether the node can receive focus. No Yes
Visible When disabled the scene graph node is not rendered No Yes
Transition Phase The phase of the transition. For example, use for pixel-based effects. No Yes
Description Add a description of the purpose of this item. To export descriptions
to a plain text file, select File > Export > Export Descriptions.
When you export the kzb file, this description is not included in the
exported file.		 No No
Foreground Brush The foreground brush to paint the foreground of 2D nodes. No Yes
Composition Brush The brush to use to compose 2D nodes to screen. No Yes
Foreground Hint Give a hint of the type of the foreground of 2D nodes:
- None renders the background brush after rendering the node.
- Translucent renders the background brush before the content of the node.
- Occluding renders the background brush.		 No Yes

Image messages

Name Description Inherited Exported to Kanzi Engine
Click Occurs when the pointer is pressed and is released on top of the component and no other gesture has been recognized. No Yes
Click Begin Occurs when the pointer is pressed down on top of the component. No Yes
Click Cancel Occurs when a started click cancels. This occurs, for example, when user pressed button down and slides finger away and releases press. No Yes
Click Enter Occurs when the pointer or touch enters the click manipulator. No Yes
Click Leave Occurs when the pointer or touch leaves the click manipulator. No Yes
Long Press Occurs when the pointer is pressed down on the button and 500ms has been passed. No Yes
Multi Click Occurs when the pointer is pressed and released specified number of times (default 2) within specified amount of time (default 250ms) on top of the control. No Yes
On Attached This trigger is set off when the item is initialized. For example, when you add a node to the scene graph, or enter a state that contains this trigger. No Yes
On Property Change Occurs when a property is changed No Yes
On Timer Occurs when timer interval is elapsed No Yes
Animation Playback Completed Occurs when animation player completes animation playback. No Yes
Animation Playback Started Occurs when animation player starts animation playback. No Yes
Animation Playback Stopped Occurs when animation player stops animation playback. No Yes
Interpolation Completed Occurs when property target interpolator completes interpolation. No Yes
Button: Cancel Occurs when a finger is lifted outside of a button that was previously pressed. No Yes
Button: Down Occurs when the button is pressed. No Yes
Button: Enter Occurs when a finger that presses a button enters the button's area. No Yes
Button: Leave Occurs when a finger that presses a button leaves the button's area. No Yes
Button: Long Press Occurs when a long press on the button happens. No Yes
Button: State Toggled Occurs when the button's toggle state changes. No Yes
Drag And Drop Finished Occurs when drag and drop gesture has finished. No Yes
Drag And Drop Moved Occurs on finger move after successfully starting the drag and drop with long press. No Yes
Drag And Drop Started Occurs on successfull long press on the node. No Yes
Key Down Occurs when the user presses a specific key on their keyboard. No Yes
Key Up Occurs when the user releases a specific key on their keyboard. No Yes
List Box: Item Hidden Occurs when an item is unloaded from the working memory.
To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.		 No Yes
List Box: Item Selected Occurs when an item is selected. No Yes
List Box: Item Visible Occurs when an item is loaded to the working memory.
To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.		 No Yes
List Box: Scroll Finished Occurs when list box scrolling ends. No Yes
List Box: Scroll Started Occurs when list box scrolling starts. No Yes
List Box: Scrolled Occurs when list box is scrolled. No Yes
List Box: Target Changed Occurs when list box gets a new target item. No Yes
Pan Finished Occurs when finger is raised after recognized pan gesture. No Yes
Pan Moved Occurs when finger position has changed and has exceeded recognition thresholds. No Yes
Pan Started Occurs when finger is pressed down. Pan might still be canceled if the finger is released before it has exceeded the treshold. No Yes
Pinch Finished Occurs when fingers are raised after recognized pinch gesture. No Yes
Pinch Moved Occurs first when the scale or rotation threshold is exceeded and after that when the tracked touches have moved between updates No Yes
Pinch Started Occurs when finger is pressed down. Pinch might still be canceled if finger is released before the gesture has exceeded scale or rotate threshold. No Yes
Asynchronous Load Completed Occurs when asynchronous loading of resources from a prefab has been finished. No Yes
Range Concept: Value Change Finished Occurs when the range value stops changing. No Yes
Range Concept: Value Change Started Occurs when the range value starts changing. No Yes
Range Concept: Value Changed Occurs when the range value has changed. No Yes
Scroll Ended Occurs when the scroll position of a Scroll View node stops changing. No Yes
Scroll Started Occurs when the scroll position of a Scroll View node starts changing. No Yes
Scroll Zoomed Occurs when the zoom level of a Scroll View node changes. No Yes
Scrolled Occurs when the scroll position of a Scroll View node changes. No Yes
Snap Request Occurs when a Scroll View node requests snapping target from the hosting component. No Yes
User Scroll Ended Message Occurs when the user stops scrolling a Scroll View node. No Yes
User Scroll Started Occurs when the user starts scrolling a Scroll View node. No Yes
Entered State Occurs when a state manager has entered a state. No Yes
Left State Occurs when a state manager has left a state. No Yes
Toggle Button Group: Toggled Occurs when a button in the group is toggled on. No Yes
Button: Click Occurs when a finger is lifted on top of a button that was previously pressed and when a pressed button's repeat interval expires. No Yes
Toggle Button: Toggled Off Occurs when the toggle button is toggled off. No Yes
Toggle Button: Toggled On Occurs when the toggle button is toggled on. No Yes
Page Activated Page has been activated. No Yes
Page Deactivated Page has been deactivated. No Yes
Page Navigation Finished Page host has finished navigation process. No Yes
Page Navigation Started Page host has started navigation process. No Yes

See also

Using the Image node

Open topic with navigation